<?php

/*
 * Copyright 2008 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#namespace tehframework\annotations;

#use \BadMethodCallException;

abstract class Tag
{
	/**
	 * Returns a name of the tag.
	 * 
	 * @return string
	 *         A name of the tag.
	 */
	abstract public function getName();
	
	/**
	 * Constructs a new DocBlock tag from the definition.
	 *
	 * @param TagDefinition $tagDefinition
	 *        A definition of the tag to construct.
	 * @throws BadMethodCallException
	 */
	public function __construct(TagDefinition $tagDefinition)
	{
		if (strtolower($tagDefinition->name) !== strtolower($this->getName()))
		{
			throw new BadMethodCallException(sprintf(
				'Invalid definition specified for [%s] tag: [%s].',
				$this->getName(), $tagDefinition->name
			));
		}
		
		$this->parseDocString($tagDefinition->docString);
	}
	
	/**
	 * @return string
	 */
	public function __toString()
	{
		return '@' . $this->getName();
	}
	
	/**
	 * @param  string $docString
	 */
	protected function parseDocString($docString)
	{
		
	}
}